Skip to content

docs: document create template and PDF outline upload [sc-17034] - #1453

Merged
emmavdh merged 1 commit into
mainfrom
emma/sc-17034/documentation-net-new-document-templates
Jul 30, 2026
Merged

docs: document create template and PDF outline upload [sc-17034]#1453
emmavdh merged 1 commit into
mainfrom
emma/sc-17034/documentation-net-new-document-templates

Conversation

@emmavdh

@emmavdh emmavdh commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

What and why?

Documents net-new document template creation for SC-17034 covering shipped work from SC-16316.

Implementation: frontend#2637, backend#3240.

Before: Manage document templates covered view, outline edit, swap, duplicate (details page only), and delete — but not creating a blank template or generating an outline from PDF.

After:

  • Intro and prerequisites distinguish Create Template / Delete Template (Customer Admin) vs swap permissions
  • New Create document templates section: create blank template under Development / Validation / Monitoring / Custom, then Build Outline Manually or Start Outline From PDF
  • PDF limits and structure-only outline behavior documented; progress tracked in My Inbox
  • Duplicate documents both list Actions menu and template details
  • FAQ notes create-from-scratch / PDF outline option

How to test

  1. Mark this PR ready for review (draft PRs skip the preview validate job).
  2. Wait for the validate check to pass and deploy the hosted preview.
  3. Review:
  4. Confirm create flow matches Settings → Documents → Templates → Create [Type] Template, then blank-outline manual vs PDF options.
  5. Confirm duplicate from list Actions and from details still match.

Production for comparison:

Optional local render:

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/templates/manage-document-templates.qmd \
  training/administrator-fundamentals/customizing-your-inventory.qmd \
  faq/faq-documentation.qmd

What needs special review?

  • Create modal does not ask for template type; type comes from the active Templates tab (shipped FE), not the original AC mock that included a type dropdown.
  • PDF outline is structure-only (empty text placeholders); charts/graphics are not converted to test/metric blocks.
  • Follow-up backend#3415 (cancel stuck PDF parse) is not documented here.

Dependencies, breaking changes, and deployment notes

  • Depends on merged FE/BE for SC-16316
  • No breaking docs changes

Release notes

Customer Admins can create blank document templates under each document type, or generate a structure-only outline from a PDF with selectable text. Duplicate and delete remain available from the templates list and template details. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied (documentation)
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

Cover Settings Templates create-from-scratch and PDF outline flows from SC-16316, and list-row duplicate actions.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh emmavdh added the documentation Improvements or additions to documentation label Jul 30, 2026
@CLAassistant

CLAassistant commented Jul 30, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@emmavdh
emmavdh marked this pull request as ready for review July 30, 2026 18:47
@emmavdh
emmavdh force-pushed the emma/sc-17034/documentation-net-new-document-templates branch from 32660fe to 3b6d67b Compare July 30, 2026 19:02
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@cachafla cachafla left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome 👏

@emmavdh
emmavdh added this pull request to the merge queue Jul 30, 2026
Merged via the queue into main with commit 3919e50 Jul 30, 2026
4 of 5 checks passed
@emmavdh
emmavdh deleted the emma/sc-17034/documentation-net-new-document-templates branch July 30, 2026 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants